Remove false claim of dirname parameter from Folder::remove doc comment #48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously the documentation comment claimed the function had a `dirname` parameter even though the function does not have any parameters.
per1234
added
type: imperfection
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously the documentation comment claimed the function had a
dirnameparameter even though the function does not have any parameters.This only fixes the comment, leaving the incorrect information in the API docs:
Arduino_UnifiedStorage/docs/api.md
Lines 203 to 212 in 7fd805e
That should be resolved by regenerating the documentation from the source code.
Originally reported at f77f873#r145141720